// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package errors

import (
	"errors"
	"fmt"

	xerrors "github.com/m3db/m3/src/x/errors"
)

var (
	// ErrTooFuture is returned for a write which is too far in the future.
	ErrTooFuture = xerrors.NewInvalidParamsError(errors.New("datapoint is too far in the future"))

	// ErrTooPast is returned for a write which is too far in the past.
	ErrTooPast = xerrors.NewInvalidParamsError(errors.New("datapoint is too far in the past"))

	// ErrColdWritesNotEnabled is returned when cold writes are disabled
	// and a write is too far in the past or future. Note, the error intentionally
	// excludes anything regarding the cold writes feature until its release.
	ErrColdWritesNotEnabled = xerrors.NewInvalidParamsError(errors.New(
		"datapoint is too far in the past or future"))
)

// NewUnknownNamespaceError returns a new error indicating an unknown namespace parameter.
func NewUnknownNamespaceError(namespace string) error {
	return xerrors.NewInvalidParamsError(unknownNamespace{namespace})
}

type unknownNamespace struct {
	namespace string
}

func (e unknownNamespace) Error() string {
	return fmt.Sprintf("unknown namespace: %s", e.namespace)
}

// IsUnknownNamespaceError returns true if this is an unknown namespace.
func IsUnknownNamespaceError(err error) bool {
	nsErr := xerrors.GetInnerInvalidParamsError(err)
	if nsErr == nil {
		return false
	}
	_, ok := nsErr.(unknownNamespace)
	return ok
}
